IRIX Base Documentation 1998 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmScrolledWindow.z / XmScrolledWindow

Wrap

Text File | 1998-10-30 | 49KB | 661 lines

XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) NNNNAAAAMMMMEEEE XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww - The ScrolledWindow widget class SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS #include <Xm/ScrolledW.h> VVVVEEEERRRRSSSSIIIIOOOONNNN This page documents Motif 2.1. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The ScrolledWindow widget combines one or two ScrollBar widgets and a viewing area to implement a visible window onto some other (usually larger) data display. The visible part of the window can be scrolled through the larger display by the use of ScrollBars. To use ScrolledWindow, an application first creates a ScrolledWindow widget, any needed ScrollBar widgets, and a widget capable of displaying any desired data as the work area of ScrolledWindow. ScrolledWindow positions the work area widget and displays the ScrollBars if so requested. When the user performs some action on the ScrollBar, the application is notified through the normal ScrollBar callback interface. ScrolledWindow can be configured to operate automatically so that it performs all scrolling and display actions with no need for application program involvement. It can also be configured to provide a minimal support framework in which the application is responsible for processing all user input and making all visual changes to the displayed data in response to that input. When ScrolledWindow is performing automatic scrolling it creates a clipping window and automatically creates the scroll bars. Conceptually, this window becomes the viewport through which the user examines the larger underlying data area. The application simply creates the desired data, then makes that data the work area of the ScrolledWindow. When the user moves the slider to change the displayed data, the workspace is moved under the viewing area so that a new portion of the data becomes visible. Sometimes it is impractical for an application to create a large data space and simply display it through a small clipping window. For example, in a text editor, creating a single data area that consisted of a large file would involve an undesirable amount of overhead. The application needs to use a ScrolledWindow (a small viewport onto some larger data), but needs to be notified when the user scrolls the viewport so it can bring in more data from storage and update the display area. For these cases, the ScrolledWindow Page 1 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) can be configured so that it provides only visual layout support. No clipping window is created, and the application must maintain the data displayed in the work area, as well as respond to user input on the ScrollBars. The user can specify resources in a resource file for the automatically created widgets that contain the horizontal and vertical scrollbars and the clipping area of the ScrolledWindow widget. The names of these widgets are HHHHoooorrrrSSSSccccrrrroooollllllllBBBBaaaarrrr, VVVVeeeerrrrttttSSSSccccrrrroooollllllllBBBBaaaarrrr, and CCCClllliiiippppWWWWiiiinnnnddddoooowwww respectively, and remain consistent whether created by XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSccccrrrroooolllllllleeeeddddLLLLiiiisssstttt, XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSccccrrrroooolllllllleeeeddddTTTTeeeexxxxtttt or XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww. ScrolledWindow uses the _X_m_Q_T_n_a_v_i_g_a_t_o_r trait, and holds the _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e trait. DDDDeeeesssscccceeeennnnddddaaaannnnttttssss ScrolledWindow automatically creates the descendants shown in the following table. An application can use XXXXttttNNNNaaaammmmeeeeTTTTooooWWWWiiiiddddggggeeeetttt to gain access to the named descendant. In addition, a user or an application can use the named descendant when specifying resource values. NNNNaaaammmmeeeedddd DDDDeeeesssscccceeeennnnddddaaaannnntttt CCCCllllaaaassssssss IIIIddddeeeennnnttttiiiittttyyyy ______________________________________________________________________________________________________________ VVVVeeeerrrrttttSSSSccccrrrroooollllllllBBBBaaaarrrr XXXXmmmmSSSSccccrrrroooollllllllBBBBaaaarrrr vertical scroll bar HHHHoooorrrrSSSSccccrrrroooollllllllBBBBaaaarrrr XXXXmmmmSSSSccccrrrroooollllllllBBBBaaaarrrr horizontal scroll bar CCCClllliiiippppWWWWiiiinnnnddddoooowwww XXXXmmmmCCCClllliiiippppWWWWiiiinnnnddddoooowwww clip window CCCCllllaaaasssssssseeeessss ScrolledWindow inherits behavior, resources, and traits from CCCCoooorrrreeee, CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr. The class pointer is _x_m_S_c_r_o_l_l_e_d_W_i_n_d_o_w_W_i_d_g_e_t_C_l_a_s_s. The class name is XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww. NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss The following table defines a set of widget resources used by the programmer to specify data. The programmer can also set the resource values for the inherited classes to set attributes for this widget. To reference a resource by name or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC prefix and use the remaining letters. To specify one of the defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmm prefix and use the remaining letters (in either lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (C), set by using XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is not applicable (N/A). Page 2 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNautoDragModel XmCAutoDragModel XtEnum XmAUTO_DRAG_ENABLED CSG XmNclipWindow XmCClipWindow Widget dynamic G XmNhorizontalScrollBar XmCHorizontalScrollBar Widget dynamic CSG XmNscrollBarDisplayPolicy XmCScrollBarDisplayPolicy unsigned char dynamic CSG XmNscrollBarPlacement XmCScrollBarPlacement unsigned char XmBOTTOM_RIGHT CSG XmNscrolledWindowMarginHeight XmCScrolledWindowMarginHeight Dimension 0 CSG XmNscrolledWindowMarginWidth XmCScrolledWindowMarginWidth Dimension 0 CSG XmNscrollingPolicy XmCScrollingPolicy unsigned char XmAPPLICATION_DEFINED CG XmNspacing XmCSpacing Dimension 4 CSG XmNtraverseObscuredCallback XmCCallback XtCallbackList NULL CSG XmNverticalScrollBar XmCVerticalScrollBar Widget dynamic CSG XmNvisualPolicy XmCVisualPolicy unsigned char dynamic G XmNworkWindow XmCWorkWindow Widget NULL CSG XXXXmmmmNNNNaaaauuuuttttooooDDDDrrrraaaaggggMMMMooooddddeeeellll Indicates whether automatic drag is enabled (XXXXmmmmAAAAUUUUTTTTOOOO____DDDDRRRRAAAAGGGG____EEEENNNNAAAABBBBLLLLEEEEDDDDor disabled (XXXXmmmmAAAAUUUUTTTTOOOO____DDDDRRRRAAAAGGGG____DDDDIIIISSSSAAAABBBBLLLLEEEEDDDD). By default it is enabled. XXXXmmmmNNNNcccclllliiiippppWWWWiiiinnnnddddoooowwww Specifies the widget ID of the clipping area. This is automatically created by ScrolledWindow when the XXXXmmmmNNNNvvvviiiissssuuuuaaaallllPPPPoooolllliiiiccccyyyy resource is set to XXXXmmmmCCCCOOOONNNNSSSSTTTTAAAANNNNTTTT and can only be read by the application. Any attempt to set this resource to a new value causes a warning message to be printed by the scrolled window. If the XXXXmmmmNNNNvvvviiiissssuuuuaaaallllPPPPoooolllliiiiccccyyyy resource is set to XXXXmmmmVVVVAAAARRRRIIIIAAAABBBBLLLLEEEE, this resource is set to NULL, and no clipping window is created. XXXXmmmmNNNNhhhhoooorrrriiiizzzzoooonnnnttttaaaallllSSSSccccrrrroooollllllllBBBBaaaarrrr Specifies the widget ID of the horizontal ScrollBar. This is automatically created by ScrolledWindow when the XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is initialized to XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC; otherwise, the default is NULL. XXXXmmmmNNNNssssccccrrrroooollllllllBBBBaaaarrrrDDDDiiiissssppppllllaaaayyyyPPPPoooolllliiiiccccyyyy Controls the automatic placement of the ScrollBars. If it is set to XXXXmmmmAAAASSSS____NNNNEEEEEEEEDDDDEEEEDDDD and if XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is set to XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, ScrollBars are displayed only if the workspace exceeds the clip area in one or both dimensions. A resource value of XXXXmmmmSSSSTTTTAAAATTTTIIIICCCC causes the ScrolledWindow to display the ScrollBars whenever they are managed, regardless of the relationship between the clip window and the work area. This resource must be XXXXmmmmSSSSTTTTAAAATTTTIIIICCCC when XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAPPPPPPPPLLLLIIIICCCCAAAATTTTIIIIOOOONNNN____DDDDEEEEFFFFIIIINNNNEEEEDDDD. The default is XXXXmmmmAAAASSSS____NNNNEEEEEEEEDDDDEEEEDDDD when XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is Page 3 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, and XXXXmmmmSSSSTTTTAAAATTTTIIIICCCC otherwise. XXXXmmmmNNNNssssccccrrrroooollllllllBBBBaaaarrrrPPPPllllaaaacccceeeemmmmeeeennnntttt Specifies the positioning of the ScrollBars in relation to the work window. The values are XXXXmmmmTTTTOOOOPPPP____LLLLEEEEFFFFTTTT The horizontal ScrollBar is placed above the work window; the vertical ScrollBar to is placed the left. XXXXmmmmBBBBOOOOTTTTTTTTOOOOMMMM____LLLLEEEEFFFFTTTT The horizontal ScrollBar is placed below the work window; the vertical ScrollBar to is placed the left. XXXXmmmmTTTTOOOOPPPP____RRRRIIIIGGGGHHHHTTTT The horizontal ScrollBar is placed above the work window; the vertical ScrollBar to is placed the right. XXXXmmmmBBBBOOOOTTTTTTTTOOOOMMMM____RRRRIIIIGGGGHHHHTTTT The horizontal ScrollBar is placed below the work window; the vertical ScrollBar to is placed the right. The default value depends on the value of the XXXXmmmmNNNNllllaaaayyyyoooouuuuttttDDDDiiiirrrreeeeccccttttiiiioooonnnn resource of the widget. XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt Specifies the margin height on the top and bottom of the ScrolledWindow. In order to use the autoscroll drag feature of the Motif drag and drop facility, a user must be able to hold a drag icon over the margin of a scrolled window. Though drag and drop will work with the default margin size of zero, a user may find it difficult to position the icon precisely enough to use the feature easily. The application programmer should ensure that the window margins are set to an adequate size, if the use of the autoscroll drag feature is desired. XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh Specifies the margin width on the right and left sides of the ScrolledWindow. Please refer to the warning concerning the default margin size for the XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt resource, above. XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy Performs automatic scrolling of the work area with no application interaction. If the value of this resource is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, ScrolledWindow Page 4 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) automatically creates the ScrollBars; attaches callbacks to the ScrollBars; sets the visual policy to XXXXmmmmCCCCOOOONNNNSSSSTTTTAAAANNNNTTTT; and automatically moves the work area through the clip window in response to any user interaction with the ScrollBars. An application can also add its own callbacks to the ScrollBars. This allows the application to be notified of a scroll event without having to perform any layout procedures. _N_O_T_E: Since the ScrolledWindow adds callbacks to the ScrollBars, an application should not perform an XXXXttttRRRReeeemmmmoooovvvveeeeAAAAllllllllCCCCaaaallllllllbbbbaaaacccckkkkssss on any of the ScrollBar widgets. When XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is set to XXXXmmmmAAAAPPPPPPPPLLLLIIIICCCCAAAATTTTIIIIOOOONNNN____DDDDEEEEFFFFIIIINNNNEEEEDDDD, the application is responsible for all aspects of scrolling. The ScrollBars must be created by the application, and it is responsible for performing any visual changes in the work area in response to user input. This resource must be set to the desired policy at the time the ScrolledWindow is created. It cannot be changed through SSSSeeeettttVVVVaaaalllluuuueeeessss. XXXXmmmmNNNNssssppppaaaacccciiiinnnngggg Specifies the distance that separates the ScrollBars from the work window. XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk Specifies a list of callbacks that is called when traversing to a widget or gadget that is obscured due to its position in the work area relative to the location of the ScrolledWindow viewport. This resource is valid only when XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC. If this resource is NULL, an obscured widget cannot be traversed to. The callback reason is XXXXmmmmCCCCRRRR____OOOOBBBBSSSSCCCCUUUURRRREEEEDDDD____TTTTRRRRAAAAVVVVEEEERRRRSSSSAAAALLLL. XXXXmmmmNNNNvvvveeeerrrrttttiiiiccccaaaallllSSSSccccrrrroooollllllllBBBBaaaarrrr Specifies the widget ID of the vertical ScrollBar. This is automatically created by ScrolledWindow when the XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is initialized to XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC; otherwise, the default is NULL. XXXXmmmmNNNNvvvviiiissssuuuuaaaallllPPPPoooolllliiiiccccyyyy Enlarges the ScrolledWindow to match the size of the work area. It can also be used as a static viewport onto a larger data space. If the visual policy is XXXXmmmmVVVVAAAARRRRIIIIAAAABBBBLLLLEEEE, the ScrolledWindow forces Page 5 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) the ScrollBar display policy to XXXXmmmmSSSSTTTTAAAATTTTIIIICCCC and allows the work area to grow or shrink at any time and adjusts its layout to accommodate the new size. When the policy is XXXXmmmmCCCCOOOONNNNSSSSTTTTAAAANNNNTTTT, the work area grows or shrinks as requested, but a clipping window forces the size of the visible portion to remain constant. The only time the viewing area can grow is in response to a resize from the ScrolledWindow's parent. The default is XXXXmmmmCCCCOOOONNNNSSSSTTTTAAAANNNNTTTT when XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, and XXXXmmmmVVVVAAAARRRRIIIIAAAABBBBLLLLEEEE otherwise. _N_O_T_E: This resource must be set to the desired policy at the time the ScrolledWindow is created. It cannot be changed through SSSSeeeettttVVVVaaaalllluuuueeeessss. XXXXmmmmNNNNwwwwoooorrrrkkkkWWWWiiiinnnnddddoooowwww Specifies the widget ID of the viewing area. XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNscrolledWindowChildType XmCScrolledWindowChildType unsigned char RESOURCE_DEFAULT CSG XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwCCCChhhhiiiillllddddTTTTyyyyppppeeee Specifies what the child is. ScrolledWindow supports a number of child types. The possible values are: XXXXmmmmWWWWOOOORRRRKKKK____AAAARRRREEEEAAAA Indicates a work area child. This specifies that both ScrollBars are limited to moving the child inside the clipping window. If the scrolling policy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, the work area child can move in both directions. XXXXmmmmHHHHOOOORRRR____SSSSCCCCRRRROOOOLLLLLLLLBBBBAAAARRRR Indicates a horizontal child widget; the child must have the _X_m_Q_T_n_a_v_i_g_a_t_o_r trait installed. For example, the XXXXmmmmSSSSccccrrrroooollllllllBBBBaaaarrrr widget has the _X_m_Q_T_n_a_v_i_g_a_t_o_r trait installed. XXXXmmmmVVVVEEEERRRRTTTT____SSSSCCCCRRRROOOOLLLLLLLLBBBBAAAARRRR Indicates a vertical child widget; the child must have the _X_m_Q_T_n_a_v_i_g_a_t_o_r trait installed. XXXXmmmmSSSSCCCCRRRROOOOLLLLLLLL____HHHHOOOORRRR Indicates that only the horizontal ScrollBar moves the child. This value is only meaningful if the scrolling policy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC. Page 6 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) XXXXmmmmSSSSCCCCRRRROOOOLLLLLLLL____VVVVEEEERRRRTTTT Indicates that only the vertical ScrollBar moves the child. This value is only meaningful if the scrolling policy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC. XXXXmmmmNNNNOOOO____SSSSCCCCRRRROOOOLLLLLLLL Indicates that the child does not move with the ScrollBars. This value is only meaningful if the scrolling policy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC. IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss ScrolledWindow inherits behavior and resources from the superclasses described in the following tables. For a complete description of each resource, refer to the reference page for that superclass. XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic CSG XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNforeground XmCForeground Pixel dynamic CSG XmNhelpCallback XmCCallback XtCallbackList NULL C XmNhighlightColor XmCHighlightColor Pixel dynamic CSG XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG XmNinitialFocus XmCInitialFocus Widget NULL CSG XmNlayoutDirection XmCLayoutDirection XmDirection dynamic CG XmNnavigationType XmCNavigationType XmNavigationType XmTAB_GROUP CSG XmNpopupHandlerCallback XmCCallback XtCallbackList NULL C XmNshadowThickness XmCShadowThickness Dimension dynamic CSG XmNstringDirection XmCStringDirection XmStringDirection dynamic CG XmNtopShadowColor XmCTopShadowColor Pixel dynamic CSG XmNtopShadowPixmap XmCTopShadowPixmap Pixmap dynamic CSG XmNtraversalOn XmCTraversalOn Boolean True CSG XmNunitType XmCUnitType unsigned char dynamic CSG XmNuserData XmCUserData XtPointer NULL CSG CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNchildren XmCReadOnly WidgetList NULL G XmNinsertPosition XmCInsertPosition XtOrderProc NULL CSG XmNnumChildren XmCReadOnly Cardinal 0 G CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNaccelerators XmCAccelerators XtAccelerators dynamic CSG XmNancestorSensitive XmCSensitive Boolean dynamic G XmNbackground XmCBackground Pixel dynamic CSG XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG Page 7 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNborderWidth XmCBorderWidth Dimension 0 CSG XmNcolormap XmCColormap Colormap dynamic CG XmNdepth XmCDepth int dynamic CG XmNdestroyCallback XmCCallback XtCallbackList NULL C XmNheight XmCHeight Dimension dynamic CSG XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG XmNscreen XmCScreen Screen * dynamic CG XmNsensitive XmCSensitive Boolean True CSG XmNtranslations XmCTranslations XtTranslations dynamic CSG XmNwidth XmCWidth Dimension dynamic CSG XmNx XmCPosition Position 0 CSG XmNy XmCPosition Position 0 CSG CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn The application must use the ScrollBar callbacks to be notified of user input. ScrolledWindow defines a callback structure for use with XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk callbacks. The XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk resource provides a mechanism for traversal to obscured widgets (or gadgets) due to their position in the work area of a ScrolledWindow. The XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk routine has responsibility for adjusting the position of the work area such that the specified traversal destination widget is positioned within the viewport of the ScrolledWindow. A NULL XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkkresource causes obscured widgets within the ScrolledWindow to be nontraversable. Traversal to an obscured widget or gadget requires these conditions to be met: the widget or gadget can be obscured only due to its position in the work area of a ScrolledWindow relative to the viewport; the viewport of the associated ScrolledWindow is fully visible, or can be made so by virtue of ancestral XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk routines; and the XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk resource must be non-NULL. When ScrolledWindow widgets are nested, the XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk routine for each ScrolledWindow that obscures the traversal destination is called in ascending order within the given hierarchy. A pointer to the following structure is passed to callbacks for XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrsssseeeeOOOObbbbssssccccuuuurrrreeeeddddCCCCaaaallllllllbbbbaaaacccckkkk. typedef struct { int _r_e_a_s_o_n; Page 8 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) XEvent *_e_v_e_n_t: Widget _t_r_a_v_e_r_s_a_l__d_e_s_t_i_n_a_t_i_o_n; XmTraversalDirection _d_i_r_e_c_t_i_o_n; } XmTraverseObscuredCallbackStruct; _r_e_a_s_o_n Indicates why the callback was invoked. _e_v_e_n_t Points to the _X_E_v_e_n_t that triggered the callback. _t_r_a_v_e_r_s_a_l__d_e_s_t_i_n_a_t_i_o_n Specifies the widget or gadget to traverse to, which will be a descendant of the work window. _d_i_r_e_c_t_i_o_n Specifies the direction of traversal. See the description of the _d_i_r_e_c_t_i_o_n parameter in the XXXXmmmmPPPPrrrroooocccceeeessssssssTTTTrrrraaaavvvveeeerrrrssssaaaallll reference page for an explanation of the valid values. TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww includes the translations from XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr. AAAAddddddddiiiittttiiiioooonnnnaaaallll BBBBeeeehhhhaaaavvvviiiioooorrrr This widget has the following additional behavior: <<<<KKKKeeeeyyyy>>>><<<<oooossssffffPPPPaaaaggggeeeeUUUUpppp>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window up the height of the viewport. The distance scrolled may be reduced to provide some overlap. The actual distance scrolled depends on the XXXXmmmmNNNNppppaaaaggggeeeeIIIInnnnccccrrrreeeemmmmeeeennnntttt resource of the vertical ScrollBar. <<<<KKKKeeeeyyyy>>>><<<<oooossssffffPPPPaaaaggggeeeeDDDDoooowwwwnnnn>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window down the height of the viewport. The distance scrolled may be reduced to provide some overlap. The actual distance scrolled depends on the XXXXmmmmNNNNppppaaaaggggeeeeIIIInnnnccccrrrreeeemmmmeeeennnntttt resource of the vertical ScrollBar. <<<<KKKKeeeeyyyy>>>><<<<oooossssffffPPPPaaaaggggeeeeLLLLeeeefffftttt>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window left the width of the viewport. The distance scrolled may be reduced to provide some overlap. The actual distance scrolled depends on the XXXXmmmmNNNNppppaaaaggggeeeeIIIInnnnccccrrrreeeemmmmeeeennnntttt resource of the horizontal ScrollBar. <<<<KKKKeeeeyyyy>>>><<<<oooossssffffPPPPaaaaggggeeeeRRRRiiiigggghhhhtttt>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window right the width of the viewport. The distance scrolled may be reduced to provide some Page 9 (printed 10/24/98) XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX)))) overlap. The actual distance scrolled depends on the XXXXmmmmNNNNppppaaaaggggeeeeIIIInnnnccccrrrreeeemmmmeeeennnntttt resource of the horizontal ScrollBar. <<<<KKKKeeeeyyyy>>>><<<<oooossssffffBBBBeeeeggggiiiinnnnLLLLiiiinnnneeee>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window horizontally to the edge corresponding to the horizontal ScrollBar's minimum value. <<<<KKKKeeeeyyyy>>>><<<<oooossssffffEEEEnnnnddddLLLLiiiinnnneeee>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window horizontally to the edge corresponding to the horizontal ScrollBar's maximum value. <<<<KKKKeeeeyyyy>>>><<<<oooossssffffBBBBeeeeggggiiiinnnnDDDDaaaattttaaaa>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window vertically to the edge corresponding to the vertical ScrollBar's minimum value. <<<<KKKKeeeeyyyy>>>><<<<oooossssffffEEEEnnnnddddDDDDaaaattttaaaa>>>>: If XXXXmmmmNNNNssssccccrrrroooolllllllliiiinnnnggggPPPPoooolllliiiiccccyyyy is XXXXmmmmAAAAUUUUTTTTOOOOMMMMAAAATTTTIIIICCCC, scrolls the window vertically to the edge corresponding to the vertical ScrollBar's maximum value. Certain applications will want to replace the page bindings with ones that are specific to the content of the scrolled area. VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss The bindings for virtual keys are vendor specific. For information about bindings for virtual buttons and keys, see VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss(3). RRRREEEELLLLAAAATTTTEEEEDDDD CCCCoooommmmppppoooossssiiiitttteeee(3), CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt(3), CCCCoooorrrreeee(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww(3), XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr(3), XXXXmmmmPPPPrrrroooocccceeeessssssssTTTTrrrraaaavvvveeeerrrrssssaaaallll(3), XXXXmmmmSSSSccccrrrroooollllllllBBBBaaaarrrr(3), XXXXmmmmSSSSccccrrrroooollllllllVVVViiiissssiiiibbbblllleeee(3), and XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwSSSSeeeettttAAAArrrreeeeaaaassss(3). Page 10 (printed 10/24/98)